#!/bin/bash
#
# Copyright (C) 2015 Julien Desfossez <jdesfossez@efficios.com>
#
# SPDX-License-Identifier: GPL-2.0-only
#

# WARNING: this test changes the date of the system (and does not set it back).
# This test sets the date of the current machine to $DATE1, creates a trace
# makes sure the trace is really at that date, then restarts the trace, changes
# the date to $DATE2, regenerates the metadata and validates that the trace is
# actually at $DATE2.

TEST_DESC="Metadata regeneration after date change"

CURDIR=$(dirname "$0")/
TESTDIR=$CURDIR/..
NUM_TESTS=44
SESSION_NAME="regen"
KERNEL_EVENT_NAME="lttng_test_filter_event"
TRACE_PATH=$(mktemp -d -t tmp.metadata_regen_after_data_change.XXXXXX)

TESTAPP_PATH="$TESTDIR/utils/testapp"
TESTAPP_NAME="gen-ust-events"
TESTAPP_BIN="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
NR_ITER=1
NR_USEC_WAIT=0
UST_EVENT_NAME="tp:tptest"

DATE1="1970-02-02"
DATE2="1980-02-02"
HOUR="05:30"

source "$TESTDIR/utils/utils.sh"

# MUST set TESTDIR before calling those functions
plan_tests $NUM_TESTS

print_test_banner "$TEST_DESC"

bail_out_if_no_babeltrace


function validate_trace_date
{
	local test_date=$1
	local trace_path=$2

	res=$(_run_babeltrace_cmd --clock-date "$trace_path" | head -1 | grep $test_date)
	if [ $? -eq 0 ]; then
		pass "Validate trace at date $test_date"
		ret=0
	else
		fail "The trace is not at the expected date"
		ret=-1
	fi

	return $ret
}

function test_kernel_local ()
{
	diag "Test kernel local with metadata regeneration"
	date "+%Y-%m-%d %H:%M" -s "$DATE1 $HOUR" >/dev/null
	create_lttng_session_ok $SESSION_NAME "$TRACE_PATH"
	lttng_enable_kernel_event $SESSION_NAME $KERNEL_EVENT_NAME
	start_lttng_tracing_ok $SESSION_NAME
	echo -n "100" > /proc/lttng-test-filter-event
	stop_lttng_tracing_ok $SESSION_NAME
	validate_trace_date $DATE1 "$TRACE_PATH"
	start_lttng_tracing_ok $SESSION_NAME
	date "+%Y-%m-%d %H:%M" -s "$DATE2 $HOUR" >/dev/null
	regenerate_metadata_ok $SESSION_NAME
	stop_lttng_tracing_ok $SESSION_NAME
	validate_trace_date $DATE2 "$TRACE_PATH"
	if [ $? -eq 0 ]; then
		# Only delete if successful
		rm -rf $TRACE_PATH
	fi
	destroy_lttng_session_ok $SESSION_NAME
}

function test_kernel_streaming ()
{
	diag "Test kernel streaming with metadata regeneration"
	date "+%Y-%m-%d %H:%M" -s "$DATE1 $HOUR" >/dev/null
	create_lttng_session_uri $SESSION_NAME net://localhost
	lttng_enable_kernel_event $SESSION_NAME $KERNEL_EVENT_NAME
	start_lttng_tracing_ok $SESSION_NAME
	echo -n "100" > /proc/lttng-test-filter-event
	stop_lttng_tracing_ok $SESSION_NAME
	validate_trace_date $DATE1 $TRACE_PATH/$HOSTNAME/$SESSION_NAME*
	start_lttng_tracing_ok $SESSION_NAME
	date "+%Y-%m-%d %H:%M" -s "$DATE2 $HOUR" >/dev/null
	regenerate_metadata_ok $SESSION_NAME
	stop_lttng_tracing_ok $SESSION_NAME
	# Validate test
	validate_trace_date $DATE2 $TRACE_PATH/$HOSTNAME/$SESSION_NAME*
	if [ $? -eq 0 ]; then
		# Only delete if successful
		rm -rf $TRACE_PATH
	else
		return
	fi
	destroy_lttng_session_ok $SESSION_NAME
}

function test_ust_local ()
{
	local file_sync_after_first
	local file_sync_before_last

	file_sync_after_first=$(mktemp -u -t "tmp.${FUNCNAME[0]}_sync_after_first.XXXXXX")
	file_sync_before_last=$(mktemp -u -t "tmp.${FUNCNAME[0]}_sync_before_last.XXXXXX")

	diag "Test UST local with metadata regeneration"
	date "+%Y-%m-%d %H:%M" -s "$DATE1 $HOUR" >/dev/null
	create_lttng_session_ok $SESSION_NAME $TRACE_PATH
	enable_ust_lttng_event_ok $SESSION_NAME $UST_EVENT_NAME

	$TESTAPP_BIN -i $NR_ITER -w $NR_USEC_WAIT \
		--sync-after-first-event "${file_sync_after_first}" \
		--sync-before-last-event "${file_sync_before_last}" > /dev/null 2>&1 &

	start_lttng_tracing_ok $SESSION_NAME

	touch "${file_sync_before_last}"
	# Wait for the applications started in background
	wait

	stop_lttng_tracing_ok $SESSION_NAME
	validate_trace_date $DATE1 "$TRACE_PATH"

	start_lttng_tracing_ok $SESSION_NAME
	date "+%Y-%m-%d %H:%M" -s "$DATE2 $HOUR" >/dev/null
	regenerate_metadata_ok $SESSION_NAME

	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME
	validate_trace_date $DATE2 "$TRACE_PATH"
	if [ $? -eq 0 ]; then
		# Only delete if successful
		rm -rf "$TRACE_PATH"
	fi
	rm -f "${file_sync_after_first}"
	rm -f "${file_sync_before_last}"
}

function test_ust_streaming ()
{
	local file_sync_after_first
	local file_sync_before_last

	file_sync_after_first=$(mktemp -u -t "tmp.${FUNCNAME[0]}_sync_after_first.XXXXXX")
	file_sync_before_last=$(mktemp -u -t "tmp.${FUNCNAME[0]}_sync_before_last.XXXXXX")

	diag "Test UST streaming with metadata regeneration"
	date "+%Y-%m-%d %H:%M" -s "$DATE1 $HOUR" >/dev/null
	create_lttng_session_uri $SESSION_NAME net://localhost
	enable_ust_lttng_event_ok $SESSION_NAME $UST_EVENT_NAME

	$TESTAPP_BIN -i $NR_ITER -w $NR_USEC_WAIT \
		--sync-after-first-event "${file_sync_after_first}" \
		--sync-before-last-event "${file_sync_before_last}" > /dev/null 2>&1 &

	start_lttng_tracing_ok $SESSION_NAME

	touch "${file_sync_before_last}"

	# Wait for the applications started in background
	wait
	stop_lttng_tracing_ok $SESSION_NAME
	validate_trace_date $DATE1 $TRACE_PATH/$HOSTNAME/$SESSION_NAME*

	start_lttng_tracing_ok $SESSION_NAME
	date "+%Y-%m-%d %H:%M" -s "$DATE2 $HOUR" >/dev/null

	regenerate_metadata_ok $SESSION_NAME

	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME
	# Validate test
	validate_trace_date $DATE2 $TRACE_PATH/$HOSTNAME/$SESSION_NAME*
	if [ $? -eq 0 ]; then
		# Only delete if successful
		rm -rf "$TRACE_PATH"
	fi
	rm -f "${file_sync_after_first}"
	rm -f "${file_sync_before_last}"
}

if ! destructive_tests_enabled ; then
	echo 'Please make sure that ntp is not running while executing this test'
	skip 0 "You need to set the LTTNG_ENABLE_DESTRUCTIVE_TESTS environment variable to \"will-break-my-system\" to run this test" $NUM_TESTS

	exit 0
fi

check_skip_kernel_test $NUM_TESTS "Skipping all tests." ||
{
	original_date=$(date)
	start_lttng_relayd "-o $TRACE_PATH"
	start_lttng_sessiond

	modprobe lttng-test
	test_kernel_local
	test_kernel_streaming
	modprobe --remove lttng-test

	test_ust_local
	test_ust_streaming

	stop_lttng_sessiond
	stop_lttng_relayd

	# This set of test sets the date in the past which causes
	# `make` to panic when it sees files created in the "future"
	# while running the "check" target. Obviously this doesn't set
	# the correct date, but at least its close enough to allow the
	# test suite to continue.
	date --set "$original_date"
}
